Summary

Fully Qualified Name:	Laminas\Form\View\Helper\FormCollection
Extends:	AbstractHelper

Description

Methods

Name	Description	Defined By
__invoke()	Invoke helper as function	FormCollection
addDefaultTranslatableAttribute()	Adds an HTML attribute to the list of the default translatable attributes	AbstractHelper
addDefaultTranslatableAttributePrefix()	Adds an HTML attribute to the list of translatable attributes	AbstractHelper
addTranslatableAttribute()	Adds an HTML attribute to the list of translatable attributes	AbstractHelper
addTranslatableAttributePrefix()	Adds an HTML attribute to the list of translatable attributes	AbstractHelper
addValidAttribute()	Adds an HTML attribute to the list of valid attributes	AbstractHelper
addValidAttributePrefix()	Adds a prefix to the list of valid attribute prefixes	AbstractHelper
createAttributesString()	Create a string of all attribute/value pairs	AbstractHelper
getDefaultElementHelper()	Gets the name of the view helper that should be used to render sub elements.	FormCollection
getDoctype()	Get value for doctype	AbstractHelper
getEncoding()	Get character encoding	AbstractHelper
getId()	Get the ID of an element	AbstractHelper
getInlineClosingBracket()	Get the closing bracket for an inline tag	AbstractHelper
getLabelWrapper()	Get the wrapper for the label	FormCollection
getTemplateWrapper()	Ge the wrapper for the template	FormCollection
getTranslator()	Returns translator used in helper	AbstractTranslatorHelper
getTranslatorTextDomain()	Return the translation text domain	AbstractTranslatorHelper
getView()	Get the view object	AbstractHelper
getWrapper()	Get the wrapper for the collection	FormCollection
hasTranslator()	Checks if the helper has a translator	AbstractTranslatorHelper
isTranslatorEnabled()	Returns whether translator is enabled and should be used	AbstractTranslatorHelper
render()	Render a collection by iterating through all fieldsets and elements	FormCollection
renderTemplate()	Only render a template	FormCollection
setDefaultElementHelper()	Sets the name of the view helper that should be used to render sub elements.	FormCollection
setDoctype()	Set value for doctype	AbstractHelper
setElementHelper()	Sets the element helper that should be used by this collection.	FormCollection
setEncoding()	Set value for character encoding	AbstractHelper
setFieldsetHelper()	Sets the fieldset helper that should be used by this collection.	FormCollection
setLabelWrapper()	Set the label-wrapper The string will be passed through sprintf with the label as single parameter This defaults to ' %s '	FormCollection
setShouldWrap()	If set to true, collections are automatically wrapped around a fieldset	FormCollection
setTemplateWrapper()	Set the string where the template will be inserted into	FormCollection
setTranslator()	Sets translator to use in helper	AbstractTranslatorHelper
setTranslatorEnabled()	Sets whether translator is enabled and should be used	AbstractTranslatorHelper
setTranslatorTextDomain()	Set translation text domain	AbstractTranslatorHelper
setView()	Set the View object	AbstractHelper
setWrapper()	Set the wrapper for this collection	FormCollection
shouldWrap()	Get wrapped	FormCollection

Method Details

__invoke()

Invoke helper as function

Proxies to {@link render()}.

Parameter Name	Type	Description
$element	\ElementInterface|null
$wrap	bool

Returns: string|\FormCollection

addDefaultTranslatableAttribute()

Adds an HTML attribute to the list of the default translatable attributes

Parameter Name	Type	Description
$attribute	string

Returns:

addDefaultTranslatableAttributePrefix()

Adds an HTML attribute to the list of translatable attributes

Parameter Name	Type	Description
$prefix	string

Returns:

addTranslatableAttribute()

Adds an HTML attribute to the list of translatable attributes

Parameter Name	Type	Description
$attribute	string

Returns: $this

addTranslatableAttributePrefix()

Adds an HTML attribute to the list of translatable attributes

Parameter Name	Type	Description
$prefix	string

Returns: $this

addValidAttribute()

Adds an HTML attribute to the list of valid attributes

Parameter Name	Type	Description
$attribute	string

Returns: $this

addValidAttributePrefix()

Adds a prefix to the list of valid attribute prefixes

Parameter Name	Type	Description
$prefix	string

Returns: $this

createAttributesString()

Create a string of all attribute/value pairs

Escapes all attribute values

Parameter Name	Type	Description
$attributes	array

Returns: string

getDefaultElementHelper()

Gets the name of the view helper that should be used to render sub elements.

Returns: string

getDoctype()

Get value for doctype

Returns: string

getEncoding()

Get character encoding

Returns: string

getId()

Get the ID of an element

If no ID attribute present, attempts to use the name attribute. If no name attribute is present, either, returns null.

Parameter Name	Type	Description
$element	\ElementInterface

Returns: null|string

getInlineClosingBracket()

Get the closing bracket for an inline tag

Closes as either "/>" for XHTML doctypes or ">" otherwise.

Returns: string

getLabelWrapper()

Get the wrapper for the label

Returns: string

getTemplateWrapper()

Ge the wrapper for the template

Returns: string

getTranslator()

Returns translator used in helper

Returns: \Translator|null

getTranslatorTextDomain()

Return the translation text domain

Returns: string

getView()

Get the view object

Returns: null|\Renderer

getWrapper()

Get the wrapper for the collection

Returns: string

hasTranslator()

Checks if the helper has a translator

Returns: bool

isTranslatorEnabled()

Returns whether translator is enabled and should be used

Returns: bool

render()

Render a collection by iterating through all fieldsets and elements

Parameter Name	Type	Description
$element	\ElementInterface

Returns: string

renderTemplate()

Only render a template

Parameter Name	Type	Description
$collection	\CollectionElement

Returns: string

setDefaultElementHelper()

Sets the name of the view helper that should be used to render sub elements.

Parameter Name	Type	Description
$defaultSubHelper	string	The

Returns: $this

setDoctype()

Set value for doctype

Parameter Name	Type	Description
$doctype	string

Returns: $this

setElementHelper()

Sets the element helper that should be used by this collection.

Parameter Name	Type	Description
$elementHelper	\HelperInterface	The

Returns: $this

setEncoding()

Set value for character encoding

Parameter Name	Type	Description
$encoding	string

Returns: $this

setFieldsetHelper()

Sets the fieldset helper that should be used by this collection.

Parameter Name	Type	Description
$fieldsetHelper	\HelperInterface	The

Returns: $this

setLabelWrapper()

Set the label-wrapper The string will be passed through sprintf with the label as single parameter This defaults to '

%s

'

Parameter Name	Type	Description
$labelWrapper	string

Returns: $this

setShouldWrap()

If set to true, collections are automatically wrapped around a fieldset

Parameter Name	Type	Description
$wrap	bool

Returns: $this

setTemplateWrapper()

Set the string where the template will be inserted into

This string will be passed through sprintf and has the template as single parameter

THis defaults to ''

Parameter Name	Type	Description
$templateWrapper	string

Returns: $this

setTranslator()

Sets translator to use in helper

Parameter Name	Type	Description
$translator	\Translator|null	Default
$textDomain	string|null	Default

Returns: $this

setTranslatorEnabled()

Sets whether translator is enabled and should be used

Parameter Name	Type	Description
$enabled	bool

Returns: $this

setTranslatorTextDomain()

Set translation text domain

Parameter Name	Type	Description
$textDomain	string

Returns: $this

setView()

Set the View object

Parameter Name	Type	Description
$view	\Renderer

Returns: \AbstractHelper

setWrapper()

Set the wrapper for this collection

The string given will be passed through sprintf with the following three replacements:

1. The content of the collection
2. The label of the collection. If no label is given this will be an empty string
3. The template span-tag. This might also be an empty string

The preset default is

%2$s%1$s%3$s

Parameter Name	Type	Description
$wrapper	string

Returns: $this

shouldWrap()

Get wrapped

Returns: bool